

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>3.3.1.2. Envelope Node Recorder &mdash; OpenSees Documentation  documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../../../_static/jquery.js"></script>
        <script type="text/javascript" src="../../../_static/underscore.js"></script>
        <script type="text/javascript" src="../../../_static/doctools.js"></script>
        <script type="text/javascript" src="../../../_static/language_data.js"></script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../../_static/css/custom.css" type="text/css" />
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" />
    <link rel="next" title="3.3.1.3. Element Recorder" href="ElementRecorder.html" />
    <link rel="prev" title="3.3.1.1. Node Recorder" href="NodeRecorder.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../../../index.html">
          

          
            
            <img src="../../../_static/OpenSeesLogo.png" class="logo" alt="Logo"/>
          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Applications for Users</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../interpreters.html">1. OpenSees Interpreters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install.html">2. Installation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../userManual.html">3. Command Manual</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../modelCommands.html">3.1. Modelling Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="../analysisCommands.html">3.2. Analysis Commands</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../outputCommands.html">3.3. Output Commands</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="recorder.html">3.3.1. recorder Command</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="NodeRecorder.html">3.3.1.1. Node Recorder</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">3.3.1.2. Envelope Node Recorder</a></li>
<li class="toctree-l4"><a class="reference internal" href="ElementRecorder.html">3.3.1.3. Element Recorder</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../materialCommands.html">3.4. Material Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="../miscCommands.html">3.5. Misc. Commands</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../userExamples.html">4. Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../messageBoard.html">5. Questions, Bugs &amp; Feauture Requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../developer/license.html">6. Copyright and License</a></li>
</ul>
<p class="caption"><span class="caption-text">Framework for Developer</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../developer/sourceCode.html">1. Source Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../developer/build.html">2. Building Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../developer/references.html">3. References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../developer/extend.html">4. Extending Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../developer/contribute.html">5. Contributing Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../developer/issues.html">6. Issues</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../index.html">OpenSees Documentation</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../userManual.html"><span class="section-number">3. </span>Command Manual</a> &raquo;</li>
        
          <li><a href="../outputCommands.html"><span class="section-number">3.3. </span>Output Commands</a> &raquo;</li>
        
          <li><a href="recorder.html"><span class="section-number">3.3.1. </span>recorder Command</a> &raquo;</li>
        
      <li><span class="section-number">3.3.1.2. </span>Envelope Node Recorder</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../../../_sources/user/manual/output/EnvelopeNodeRecorder.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="envelope-node-recorder">
<span id="envelopenoderecorder"></span><h1><span class="section-number">3.3.1.2. </span>Envelope Node Recorder<a class="headerlink" href="#envelope-node-recorder" title="Permalink to this headline">¶</a></h1>
<p>The EnvelopeNode recorder type records the maxima and minima response of a number of nodes over the analysis. The command to create an envelope node recorder is:</p>
<dl class="function">
<dt>
<code class="sig-name descname">recorder</code><span class="sig-paren">(</span><em class="sig-param">EnvelopeNode</em>, <em class="sig-param">&lt;-file $filename&gt;</em>, <em class="sig-param">&lt;-xml $filename&gt;</em>, <em class="sig-param">&lt;-binary $filename&gt;</em>, <em class="sig-param">&lt;-tcp $inetAddress $port&gt;</em>, <em class="sig-param">&lt;-precision  $nSD&gt;</em>, <em class="sig-param">&lt;-timeSeries $tsTag&gt;</em>, <em class="sig-param">&lt;-time&gt;</em>, <em class="sig-param">&lt;-dT $deltaT&gt;</em>, <em class="sig-param">&lt;-closeOnWrite&gt;</em>, <em class="sig-param">&lt;-node  $nodeTags&gt;</em>, <em class="sig-param">&lt; -nodeRange $startNode $endNode&gt;</em>, <em class="sig-param">&lt;-region $regionTag&gt; -dof $dofs $respType</em><span class="sig-paren">)</span></dt>
<dd></dd></dl>

<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 17%" />
<col style="width: 17%" />
<col style="width: 67%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="head"><p>Type</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>$fileName</p></td>
<td><p><em>string</em></p></td>
<td><p>optyional: name of file to which output is sent.</p></td>
</tr>
<tr class="row-odd"><td><p>$inetAddr</p></td>
<td><p><em>string</em></p></td>
<td><p>optional: ip address (“xx.xx.xx.xx”) of remote machine</p></td>
</tr>
<tr class="row-even"><td><p>$port</p></td>
<td><p><em>integer</em></p></td>
<td><p>optional: port on remote machine awaiting tcp</p></td>
</tr>
<tr class="row-odd"><td><p>$nSD</p></td>
<td><p><em>integer</em></p></td>
<td><p>optional: number of significant digits (optional: default is 6)</p></td>
</tr>
<tr class="row-even"><td><p>-time</p></td>
<td><p><em>string</em></p></td>
<td><p>optional: places domain time in first output column.</p></td>
</tr>
<tr class="row-odd"><td><p>-closeOnWrite</p></td>
<td><p><em>string</em></p></td>
<td><p>optional: opens and closes file on each write.</p></td>
</tr>
<tr class="row-even"><td><p>$deltaT</p></td>
<td><p><em>float</em></p></td>
<td><p>optional: time interval for recording.</p></td>
</tr>
<tr class="row-odd"><td><p>$tsTag</p></td>
<td><p><em>integer</em></p></td>
<td><p>optional: the tag of a previously constructed TimeSeries.</p></td>
</tr>
<tr class="row-even"><td><p>$nodes</p></td>
<td><p><em>list integer</em></p></td>
<td><p>optional: tags of nodes whose response is being recorded</p></td>
</tr>
<tr class="row-odd"><td><p>$startNode</p></td>
<td><p><em>integer</em></p></td>
<td><p>optional: tag for start node</p></td>
</tr>
<tr class="row-even"><td><p>$startNode</p></td>
<td><p><em>integer</em></p></td>
<td><p>optional: tag for end node</p></td>
</tr>
<tr class="row-odd"><td><p>$regionTag</p></td>
<td><p><em>integer</em></p></td>
<td><p>optional: tag of previously defined region.</p></td>
</tr>
<tr class="row-even"><td><p>$dofs</p></td>
<td><p><em>list integer</em></p></td>
<td><p>list of dof at nodes whose response is requested.</p></td>
</tr>
<tr class="row-odd"><td><p>$respType</p></td>
<td><p><em>string</em></p></td>
<td><p>a string indicating response required.</p></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ol class="arabic simple">
<li><p>Only one of the options <strong>-file</strong>, <strong>-xml</strong>, <strong>-binary</strong>, or <strong>-tcp</strong> may be used. The option specifies where the data is going to be sent.</p></li>
<li><p>Similarily only one of the options: <strong>-node</strong>, <strong>-nodeRange</strong>, or <strong>-region</strong> may be used. This option specifies the node tags.</p></li>
<li><p>The valid strings for respType are:</p></li>
</ol>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>disp
vel
accel
incrDisp
eigen $mode
reaction
rayleighForces!
</pre></div>
</div>
<ol class="arabic" start="4">
<li><div class="line-block">
<div class="line">The function returns a value:</div>
<div class="line">SUCCESS: <strong>&gt;0</strong> an integer tag that can be used as a handle on the recorder for the remove a recorder in the <span class="xref std std-ref">remove</span>.</div>
<div class="line">FAILURE: <strong>-1</strong> recorder command failed (read the log)</div>
</div>
</li>
</ol>
<p>To remove a recorder using the <span class="xref std std-ref">remove</span> you need to save this tag in a variable for use later in the script.</p>
<ol class="arabic simple" start="5">
<li><p>$deltaT, time interval for recording. will record when next step is $deltaT greater than last recorder step. Not really useful for Envelope recorder, a legacy from NodeRecorder!</p></li>
<li><p>If the <strong>-timeSeries</strong> option is being used, the recorded results are those obtained from the time series for the current time added to the response quantity measures. Need as many time series tags as dof specified. Useful for obtaining for example total acceleration as opposed to relative if user using UniformAcceleration to impose a ground motion.</p></li>
<li><p>The -closeOnWrite option will slow the program down. It is useful if you want to see just exactly where the applocation is, as files are only written to disk when the operating system feels like it under typical operation.</p></li>
</ol>
</div>
<div class="admonition-example admonition">
<p class="admonition-title">Example:</p>
<p>The following examples demonstrate the use of the recorder Node command.</p>
<ol class="arabic simple">
<li><p>The first recorder will output to a file <strong>nodesD.out</strong> the displacements in <strong>x</strong> and <strong>y</strong> (<strong>1</strong> and <strong>2</strong>) directions at nodes <strong>1</strong>, <strong>2</strong>, <strong>3</strong>, and <strong>4</strong>. The output file will contain <strong>9</strong> columns (time, displacement in x and y at node 1, disp. in x and y at node 2, … , disp. x and y at node 4))</p></li>
<li><p>The second recorder will output to a file <strong>nodesA.out</strong> the total accelerations in <strong>x</strong> and <strong>y</strong> (<strong>1</strong> and <strong>2</strong>) directions at nodes <strong>1</strong>, <strong>2</strong>, <strong>3</strong>, and <strong>4</strong>. The output file will contain <strong>9</strong> columns (time, accel. in x and y at node 1, accel. in x and y at node 2, … , accel. in x and y at node 4)). The accelerations output will be the accelerations stored at the nodes added to the values obtained from the time series. The <strong>x</strong> values are the accelerations in <strong>x</strong> direction at node plus values from timeSeries <strong>1</strong>, the <strong>y</strong> values are the accelerations in <strong>y</strong> direction at nodes plus the values from timeSries <strong>2</strong>.</p></li>
</ol>
<div class="highlight-tcl notranslate"><div class="highlight"><pre><span></span><span class="nv">recorder</span> EnvelopeNode <span class="o">-</span>file nodesD.out <span class="o">-</span>time <span class="o">-</span>node <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span> <span class="o">-</span>dof <span class="mi">1</span> <span class="mi">2</span> disp<span class="k">;</span>

<span class="nv">recorder</span> EnvelopeNode <span class="o">-</span>file nodesA.out <span class="o">-</span>timeSeries <span class="mi">1</span> <span class="mi">2</span> <span class="o">-</span>time <span class="o">-</span>node <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span> <span class="o">-</span>dof <span class="mi">1</span> <span class="mi">2</span> accel<span class="k">;</span>
</pre></div>
</div>
</div>
<p>Code developed by: <strong>fmk</strong></p>
</div>


           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, The Regents of the University of California

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
    <!-- Theme Analytics -->
    <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

    ga('create', 'UA-2431545-1', 'auto');
    ga('send', 'pageview');
    </script>

    
    

  <style>
         .wy-nav-content { max-width: none; }
  </style>



</body>
</html>